<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>&quot;MiniSearch&quot; | MiniSearch</title>
	<meta name="description" content="Documentation for MiniSearch">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="../index.html" class="title">MiniSearch</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="../globals.html">Globals</a>
				</li>
				<li>
					<a href="_minisearch_.html">&quot;MiniSearch&quot;</a>
				</li>
			</ul>
			<h1>Module &quot;MiniSearch&quot;</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Classes</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"><a href="../classes/_minisearch_.minisearch.html" class="tsd-kind-icon">Mini<wbr>Search</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Type aliases</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_minisearch_.html#autovacuumoptions" class="tsd-kind-icon">Auto<wbr>Vacuum<wbr>Options</a></li>
								<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_minisearch_.html#bm25params" class="tsd-kind-icon">BM25<wbr>Params</a></li>
								<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_minisearch_.html#matchinfo" class="tsd-kind-icon">Match<wbr>Info</a></li>
								<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="_minisearch_.html#options" class="tsd-kind-icon">Options</a></li>
								<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_minisearch_.html#query" class="tsd-kind-icon">Query</a></li>
								<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_minisearch_.html#querycombination" class="tsd-kind-icon">Query<wbr>Combination</a></li>
								<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_minisearch_.html#searchoptions-1" class="tsd-kind-icon">Search<wbr>Options</a></li>
								<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_minisearch_.html#searchresult" class="tsd-kind-icon">Search<wbr>Result</a></li>
								<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_minisearch_.html#suggestion" class="tsd-kind-icon">Suggestion</a></li>
								<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_minisearch_.html#vacuumconditions" class="tsd-kind-icon">Vacuum<wbr>Conditions</a></li>
								<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_minisearch_.html#vacuumoptions" class="tsd-kind-icon">Vacuum<wbr>Options</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Type aliases</h2>
				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
					<a name="autovacuumoptions" class="tsd-anchor"></a>
					<h3>Auto<wbr>Vacuum<wbr>Options</h3>
					<div class="tsd-signature tsd-kind-icon">Auto<wbr>Vacuum<wbr>Options<span class="tsd-signature-symbol">:</span> <a href="_minisearch_.html#vacuumoptions" class="tsd-signature-type">VacuumOptions</a><span class="tsd-signature-symbol"> &amp; </span><a href="_minisearch_.html#vacuumconditions" class="tsd-signature-type">VacuumConditions</a></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/49d8d3c/src/MiniSearch.ts#L387">MiniSearch.ts:387</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Options to control auto vacuum behavior. When discarding a document with
								<a href="../classes/_minisearch_.minisearch.html#discard">MiniSearch.discard</a>, a vacuuming operation is automatically started if the
								<code>dirtCount</code> and <code>dirtFactor</code> are above the <code>minDirtCount</code> and <code>minDirtFactor</code>
								thresholds defined by this configuration. See <a href="_minisearch_.html#vacuumconditions">VacuumConditions</a> for
							details on these.</p>
						</div>
						<p>Also, <code>batchSize</code> and <code>batchWait</code> can be specified, controlling batching
						behavior (see <a href="_minisearch_.html#vacuumoptions">VacuumOptions</a>).</p>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
					<a name="bm25params" class="tsd-anchor"></a>
					<h3>BM25<wbr>Params</h3>
					<div class="tsd-signature tsd-kind-icon">BM25<wbr>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>b<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>d<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>k<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/49d8d3c/src/MiniSearch.ts#L1830">MiniSearch.ts:1830</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Parameters of the BM25+ scoring algorithm. Customizing these is almost never
								necessary, and finetuning them requires an understanding of the BM25 scoring
							model.</p>
						</div>
						<p>Some information about BM25 (and BM25+) can be found at these links:</p>
						<ul>
							<li><a href="https://en.wikipedia.org/wiki/Okapi_BM25">https://en.wikipedia.org/wiki/Okapi_BM25</a></li>
							<li><a href="https://opensourceconnections.com/blog/2015/10/16/bm25-the-next-generation-of-lucene-relevation/">https://opensourceconnections.com/blog/2015/10/16/bm25-the-next-generation-of-lucene-relevation/</a></li>
						</ul>
					</div>
					<div class="tsd-type-declaration">
						<h4>Type declaration</h4>
						<ul class="tsd-parameters">
							<li class="tsd-parameter">
								<h5>b<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Length normalization impact.</p>
									</div>
									<p>Recommended values are around <code>0.75</code>. Higher values increase the weight
										that field length has on scoring. Setting this to <code>0</code> (not recommended)
										means that the field length has no effect on scoring. Negative values are
									invalid. Defaults to <code>0.7</code>.</p>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5>d<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>BM25+ frequency normalization lower bound (usually called δ).</p>
									</div>
									<p>Recommended values are between <code>0.5</code> and <code>1</code>. Increasing this parameter
										increases the minimum relevance of one occurrence of a search term
										regardless of its (possibly very long) field length. Negative values are
									invalid. Defaults to <code>0.5</code>.</p>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5>k<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Term frequency saturation point.</p>
									</div>
									<p>Recommended values are between <code>1.2</code> and <code>2</code>. Higher values increase the
										difference in score between documents with higher and lower term
										frequencies. Setting this to <code>0</code> or a negative value is invalid. Defaults
									to <code>1.2</code></p>
								</div>
							</li>
						</ul>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
					<a name="matchinfo" class="tsd-anchor"></a>
					<h3>Match<wbr>Info</h3>
					<div class="tsd-signature tsd-kind-icon">Match<wbr>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/49d8d3c/src/MiniSearch.ts#L275">MiniSearch.ts:275</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Match information for a search result. It is a key-value object where keys
								are terms that matched, and values are the list of fields that the term was
							found in.</p>
						</div>
					</div>
					<div class="tsd-type-declaration">
						<h4>Type declaration</h4>
						<ul class="tsd-parameters">
							<li class="tsd-parameter-index-signature">
								<h5><span class="tsd-signature-symbol">[</span>term: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
							</li>
						</ul>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
					<a name="options" class="tsd-anchor"></a>
					<h3>Options</h3>
					<div class="tsd-signature tsd-kind-icon">Options&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>autoSuggestOptions<span class="tsd-signature-symbol">?: </span><a href="_minisearch_.html#searchoptions-1" class="tsd-signature-type">SearchOptions</a><span class="tsd-signature-symbol">; </span>autoVacuum<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><a href="_minisearch_.html#autovacuumoptions" class="tsd-signature-type">AutoVacuumOptions</a><span class="tsd-signature-symbol">; </span>extractField<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>document<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, fieldName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span>fields<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>idField<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>logger<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">LogLevel</span>, message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, code<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span>processTerm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>term<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, fieldName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span>searchOptions<span class="tsd-signature-symbol">?: </span><a href="_minisearch_.html#searchoptions-1" class="tsd-signature-type">SearchOptions</a><span class="tsd-signature-symbol">; </span>storeFields<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>tokenize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, fieldName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> }</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/49d8d3c/src/MiniSearch.ts#L142">MiniSearch.ts:142</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Configuration options passed to the <a href="../classes/_minisearch_.minisearch.html">MiniSearch</a> constructor</p>
						</div>
					</div>
					<h4 class="tsd-type-parameters-title">Type parameters</h4>
					<ul class="tsd-type-parameters">
						<li>
							<h4>T = <span class="tsd-signature-type">any</span></h4>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The type of documents being indexed.</p>
								</div>
							</div>
						</li>
					</ul>
					<div class="tsd-type-declaration">
						<h4>Type declaration</h4>
						<ul class="tsd-parameters">
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> auto<wbr>Suggest<wbr>Options<span class="tsd-signature-symbol">?: </span><a href="_minisearch_.html#searchoptions-1" class="tsd-signature-type">SearchOptions</a></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Default auto suggest options (see the <a href="_minisearch_.html#searchoptions-1">SearchOptions</a> type and the
										<a href="../classes/_minisearch_.minisearch.html#autosuggest">MiniSearch.autoSuggest</a> method for details)</p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> auto<wbr>Vacuum<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><a href="_minisearch_.html#autovacuumoptions" class="tsd-signature-type">AutoVacuumOptions</a></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>If <code>true</code> (the default), vacuuming is performed automatically as soon as
											<a href="../classes/_minisearch_.minisearch.html#discard">MiniSearch.discard</a> is called a certain number of times, cleaning up
											obsolete references from the index. If <code>false</code>, no automatic vacuuming is
											performed. Custom settings controlling auto vacuuming thresholds, as well
											as batching behavior, can be passed as an object (see the
										<a href="_minisearch_.html#autovacuumoptions">AutoVacuumOptions</a> type).</p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> extract<wbr>Field<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>document<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, fieldName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Function used to extract the value of each field in documents. By default,
											the documents are assumed to be plain objects with field names as keys,
											but by specifying a custom <code>extractField</code> function one can completely
										customize how the fields are extracted.</p>
									</div>
									<p>The function takes as arguments the document, and the name of the field to
									extract from it. It should return the field value as a string.</p>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5>fields<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Names of the document fields to be indexed.</p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> id<wbr>Field<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Name of the ID field, uniquely identifying a document.</p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> logger<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">LogLevel</span>, message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, code<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Function called to log messages. Arguments are a log level (&#39;debug&#39;,
											&#39;info&#39;, &#39;warn&#39;, or &#39;error&#39;), a log message, and an optional string code
										that identifies the reason for the log.</p>
									</div>
									<p>The default implementation uses <code>console</code>, if defined.</p>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> process<wbr>Term<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>term<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, fieldName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">)</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Function used to process a term before indexing or search. This can be
											used for normalization (such as stemming). By default, terms are
										downcased, and otherwise no other normalization is performed.</p>
									</div>
									<p>The function takes as arguments a term to process, and the name of the
										field it comes from. It should return the processed term as a string, or a
									falsy value to reject the term entirely.</p>
									<p>It can also return an array of strings, in which case each string in the
									returned array is indexed as a separate term.</p>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> search<wbr>Options<span class="tsd-signature-symbol">?: </span><a href="_minisearch_.html#searchoptions-1" class="tsd-signature-type">SearchOptions</a></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Default search options (see the <a href="_minisearch_.html#searchoptions-1">SearchOptions</a> type and the
										<a href="../classes/_minisearch_.minisearch.html#search">MiniSearch.search</a> method for details)</p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> store<wbr>Fields<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Names of fields to store, so that search results would include them. By
										default none, so results would only contain the id field.</p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> tokenize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, fieldName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span></h5>
							</li>
						</ul>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
					<a name="query" class="tsd-anchor"></a>
					<h3>Query</h3>
					<div class="tsd-signature tsd-kind-icon">Query<span class="tsd-signature-symbol">:</span> <a href="_minisearch_.html#querycombination" class="tsd-signature-type">QueryCombination</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/49d8d3c/src/MiniSearch.ts#L333">MiniSearch.ts:333</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Search query expression, either a query string or an expression tree
							combining several queries with a combination of AND or OR.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
					<a name="querycombination" class="tsd-anchor"></a>
					<h3>Query<wbr>Combination</h3>
					<div class="tsd-signature tsd-kind-icon">Query<wbr>Combination<span class="tsd-signature-symbol">:</span> <a href="_minisearch_.html#searchoptions-1" class="tsd-signature-type">SearchOptions</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>queries<span class="tsd-signature-symbol">: </span><a href="_minisearch_.html#query" class="tsd-signature-type">Query</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/49d8d3c/src/MiniSearch.ts#L327">MiniSearch.ts:327</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
					<a name="searchoptions-1" class="tsd-anchor"></a>
					<h3>Search<wbr>Options</h3>
					<div class="tsd-signature tsd-kind-icon">Search<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>bm25<span class="tsd-signature-symbol">?: </span><a href="_minisearch_.html#bm25params" class="tsd-signature-type">BM25Params</a><span class="tsd-signature-symbol">; </span>boost<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>boostDocument<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, term<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, storedFields<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span>combineWith<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>fields<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>filter<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>result<span class="tsd-signature-symbol">: </span><a href="_minisearch_.html#searchresult" class="tsd-signature-type">SearchResult</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span>fuzzy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>term<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, terms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span>maxFuzzy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>prefix<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>term<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, terms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span>processTerm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>term<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span>tokenize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span>weights<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>fuzzy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>prefix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/49d8d3c/src/MiniSearch.ts#L10">MiniSearch.ts:10</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Search options to customize the search behavior.</p>
						</div>
					</div>
					<div class="tsd-type-declaration">
						<h4>Type declaration</h4>
						<ul class="tsd-parameters">
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> bm25<span class="tsd-signature-symbol">?: </span><a href="_minisearch_.html#bm25params" class="tsd-signature-type">BM25Params</a></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>BM25+ algorithm parameters. Customizing these is almost never necessary,
											and finetuning them requires an understanding of the BM25 scoring model. In
											most cases, it is best to omit this option to use defaults, and instead use
										boosting to tweak scoring for specific use cases.</p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> boost<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{}</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Key-value object of field names to boosting values. By default, fields are
											assigned a boosting factor of 1. If one assigns to a field a boosting value
											of 2, a result that matches the query in that field is assigned a score
											twice as high as a result matching the query in another field, all else
										being equal.</p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> boost<wbr>Document<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, term<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, storedFields<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Function to calculate a boost factor for documents. It takes as arguments
											the document ID, and a term that matches the search in that document, and
											the value of the stored fields for the document (if any).  It should return
											a boosting factor: a number higher than 1 increases the computed score, a
											number lower than 1 decreases the score, and a falsy value skips the search
										result completely.</p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> combine<wbr>With<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>The operand to combine partial results for each term. By default it is
											&quot;OR&quot;, so results matching <em>any</em> of the search terms are returned by a
											search. If &quot;AND&quot; is given, only results matching <em>all</em> the search terms are
										returned by a search.</p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> fields<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Names of the fields to search in. If omitted, all fields are searched.</p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> filter<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>result<span class="tsd-signature-symbol">: </span><a href="_minisearch_.html#searchresult" class="tsd-signature-type">SearchResult</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Function used to filter search results, for example on the basis of stored
											fields. It takes as argument each search result and should return a boolean
										to indicate if the result should be kept or not.</p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> fuzzy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>term<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, terms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Controls whether to perform fuzzy search. It can be a simple boolean, or a
										number, or a function.</p>
									</div>
									<p>If a boolean is given, fuzzy search with a default fuzziness parameter is
									performed if true.</p>
									<p>If a number higher or equal to 1 is given, fuzzy search is performed, with
									a maximum edit distance (Levenshtein) equal to the number.</p>
									<p>If a number between 0 and 1 is given, fuzzy search is performed within a
										maximum edit distance corresponding to that fraction of the term length,
										approximated to the nearest integer. For example, 0.2 would mean an edit
										distance of 20% of the term length, so 1 character in a 5-characters term.
										The calculated fuzziness value is limited by the <code>maxFuzzy</code> option, to
									prevent slowdown for very long queries.</p>
									<p>If a function is passed, the function is called upon search with a search
										term, a positional index of that term in the tokenized search query, and
										the tokenized search query. It should return a boolean or a number, with
									the meaning documented above.</p>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Fuzzy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Controls the maximum fuzziness when using a fractional fuzzy value. This is
											set to 6 by default. Very high edit distances usually don&#39;t produce
										meaningful results, but can excessively impact search performance.</p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> prefix<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>term<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, terms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Controls whether to perform prefix search. It can be a simple boolean, or a
										function.</p>
									</div>
									<p>If a boolean is passed, prefix search is performed if true.</p>
									<p>If a function is passed, it is called upon search with a search term, the
										positional index of that search term in the tokenized search query, and the
										tokenized search query. The function should return a boolean to indicate
									whether to perform prefix search for that search term.</p>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> process<wbr>Term<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>term<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">)</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Function to process or normalize terms in the search query. By default, the
										same term processor used for indexing is used also for search.</p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> tokenize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Function to tokenize the search query. By default, the same tokenizer used
										for indexing is used also for search.</p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> weights<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>fuzzy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>prefix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Relative weights to assign to prefix search results and fuzzy search
										results. Exact matches are assigned a weight of 1.</p>
									</div>
								</div>
							</li>
						</ul>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
					<a name="searchresult" class="tsd-anchor"></a>
					<h3>Search<wbr>Result</h3>
					<div class="tsd-signature tsd-kind-icon">Search<wbr>Result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>match<span class="tsd-signature-symbol">: </span><a href="_minisearch_.html#matchinfo" class="tsd-signature-type">MatchInfo</a><span class="tsd-signature-symbol">; </span>score<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>terms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/49d8d3c/src/MiniSearch.ts#L284">MiniSearch.ts:284</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Type of the search results. Each search result indicates the document ID, the
								terms that matched, the match information, the score, and all the stored
							fields.</p>
						</div>
					</div>
					<div class="tsd-type-declaration">
						<h4>Type declaration</h4>
						<ul class="tsd-parameters">
							<li class="tsd-parameter-index-signature">
								<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Stored fields</p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>The document ID</p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5>match<span class="tsd-signature-symbol">: </span><a href="_minisearch_.html#matchinfo" class="tsd-signature-type">MatchInfo</a></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Match information, see <a href="_minisearch_.html#matchinfo">MatchInfo</a></p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5>score<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Score of the search results</p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5>terms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>List of terms that matched</p>
									</div>
								</div>
							</li>
						</ul>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
					<a name="suggestion" class="tsd-anchor"></a>
					<h3>Suggestion</h3>
					<div class="tsd-signature tsd-kind-icon">Suggestion<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>score<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>suggestion<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>terms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/49d8d3c/src/MiniSearch.ts#L253">MiniSearch.ts:253</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The type of auto-suggestions</p>
						</div>
					</div>
					<div class="tsd-type-declaration">
						<h4>Type declaration</h4>
						<ul class="tsd-parameters">
							<li class="tsd-parameter">
								<h5>score<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Score for the suggestion</p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5>suggestion<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>The suggestion</p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5>terms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Suggestion as an array of terms</p>
									</div>
								</div>
							</li>
						</ul>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
					<a name="vacuumconditions" class="tsd-anchor"></a>
					<h3>Vacuum<wbr>Conditions</h3>
					<div class="tsd-signature tsd-kind-icon">Vacuum<wbr>Conditions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>minDirtCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>minDirtFactor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/49d8d3c/src/MiniSearch.ts#L363">MiniSearch.ts:363</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Sets minimum thresholds for <code>dirtCount</code> and <code>dirtFactor</code> that trigger an
							automatic vacuuming.</p>
						</div>
					</div>
					<div class="tsd-type-declaration">
						<h4>Type declaration</h4>
						<ul class="tsd-parameters">
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> min<wbr>Dirt<wbr>Count<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Minimum <code>dirtCount</code> (number of discarded documents since the last vacuuming)
										under which auto vacuum is not triggered. It defaults to 20.</p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> min<wbr>Dirt<wbr>Factor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Minimum <code>dirtFactor</code> (proportion of discarded documents over the total)
										under which auto vacuum is not triggered. It defaults to 0.1.</p>
									</div>
								</div>
							</li>
						</ul>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
					<a name="vacuumoptions" class="tsd-anchor"></a>
					<h3>Vacuum<wbr>Options</h3>
					<div class="tsd-signature tsd-kind-icon">Vacuum<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>batchSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>batchWait<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/49d8d3c/src/MiniSearch.ts#L346">MiniSearch.ts:346</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Options to control vacuuming behavior.</p>
						</div>
						<p>Vacuuming cleans up document references made obsolete by
							<a href="../classes/_minisearch_.minisearch.html#discard">MiniSearch.discard</a> from the index. On large indexes, vacuuming is
							potentially costly, because it has to traverse the whole inverted index.
							Therefore, in order to dilute this cost so it does not negatively affects the
							application, vacuuming is performed in batches, with a delay between each
							batch. These options are used to configure the batch size and the delay
						between batches.</p>
					</div>
					<div class="tsd-type-declaration">
						<h4>Type declaration</h4>
						<ul class="tsd-parameters">
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> batch<wbr>Size<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Size of each vacuuming batch (the number of terms in the index that will be
										traversed in each batch). Defaults to 1000.</p>
									</div>
								</div>
							</li>
							<li class="tsd-parameter">
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> batch<wbr>Wait<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
								<div class="tsd-comment tsd-typography">
									<div class="lead">
										<p>Wait time between each vacuuming batch in milliseconds. Defaults to 10.</p>
									</div>
								</div>
							</li>
						</ul>
					</div>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class="globals  ">
						<a href="../globals.html"><em>Globals</em></a>
					</li>
					<li class="current tsd-kind-module">
						<a href="_minisearch_.html">&quot;<wbr>Mini<wbr>Search&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="_searchablemap_searchablemap_.html">&quot;<wbr>Searchable<wbr>Map/<wbr>Searchable<wbr>Map&quot;</a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
					<li class=" tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter">
						<a href="../classes/_minisearch_.minisearch.html" class="tsd-kind-icon">Mini<wbr>Search</a>
					</li>
					<li class=" tsd-kind-type-alias tsd-parent-kind-module">
						<a href="_minisearch_.html#autovacuumoptions" class="tsd-kind-icon">Auto<wbr>Vacuum<wbr>Options</a>
					</li>
					<li class=" tsd-kind-type-alias tsd-parent-kind-module">
						<a href="_minisearch_.html#bm25params" class="tsd-kind-icon">BM25<wbr>Params</a>
					</li>
					<li class=" tsd-kind-type-alias tsd-parent-kind-module">
						<a href="_minisearch_.html#matchinfo" class="tsd-kind-icon">Match<wbr>Info</a>
					</li>
					<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
						<a href="_minisearch_.html#options" class="tsd-kind-icon">Options</a>
					</li>
					<li class=" tsd-kind-type-alias tsd-parent-kind-module">
						<a href="_minisearch_.html#query" class="tsd-kind-icon">Query</a>
					</li>
					<li class=" tsd-kind-type-alias tsd-parent-kind-module">
						<a href="_minisearch_.html#querycombination" class="tsd-kind-icon">Query<wbr>Combination</a>
					</li>
					<li class=" tsd-kind-type-alias tsd-parent-kind-module">
						<a href="_minisearch_.html#searchoptions-1" class="tsd-kind-icon">Search<wbr>Options</a>
					</li>
					<li class=" tsd-kind-type-alias tsd-parent-kind-module">
						<a href="_minisearch_.html#searchresult" class="tsd-kind-icon">Search<wbr>Result</a>
					</li>
					<li class=" tsd-kind-type-alias tsd-parent-kind-module">
						<a href="_minisearch_.html#suggestion" class="tsd-kind-icon">Suggestion</a>
					</li>
					<li class=" tsd-kind-type-alias tsd-parent-kind-module">
						<a href="_minisearch_.html#vacuumconditions" class="tsd-kind-icon">Vacuum<wbr>Conditions</a>
					</li>
					<li class=" tsd-kind-type-alias tsd-parent-kind-module">
						<a href="_minisearch_.html#vacuumoptions" class="tsd-kind-icon">Vacuum<wbr>Options</a>
					</li>
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer class="with-border-bottom">
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
				<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="container tsd-generator">
	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>